﻿/*
Copyright 2009 Matías Fidemraizer (www.matiasfidemraizer.com).

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/

using System;

namespace Comkarl.Architecture.Patterns
{
    /// <summary>
    /// Represents the base class for exceptions where a pattern instance member is related.
    /// </summary>
    /// <typeparam name="TIdentifierName">
    /// The type for the pattern instance member identifier's name.
    /// </typeparam>
    /// <typeparam name="TPatternInstance">
    /// The type for the pattern instance.
    /// </typeparam>
    public abstract class PatternInstanceMemberException<TIdentifierName, TPatternInstance> : PatternInstanceException<TIdentifierName> where TIdentifierName : IEquatable<TIdentifierName> where TPatternInstance : PatternInstance<TIdentifierName>
    {
        /// <summary>
        /// Retrieves the instance member evolved in the exception.
        /// </summary>
        private readonly PatternInstanceMember<TIdentifierName, TPatternInstance> currentInstanceMember;

        /// <summary>
        /// Default constructor.
        /// </summary>
        /// <param name="id">
        /// The identifier for the message that is going to be shown.
        /// </param>
        /// <param name="currentInstance">
        /// The pattern instance on which the exception has been thrown.
        /// </param>
        /// <param name="currentInstanceMember">
        /// The pattern instance member evolved in the exception that has been thrown.
        /// </param>
        /// <param name="innerException">
        /// A generic exception which adds more information to the main one.
        /// </param>
        public PatternInstanceMemberException(string id, PatternInstance<TIdentifierName> currentInstance, PatternInstanceMember<TIdentifierName, TPatternInstance> currentInstanceMember, Exception innerException)
            : base(id, currentInstance, innerException)
        {
            this.currentInstanceMember = currentInstanceMember;
        }

        /// <summary>
        /// Gets the pattern instance member evolved in the exception.
        /// </summary>
        public PatternInstanceMember<TIdentifierName, TPatternInstance> CurrentInstanceMember
        {
            get
            {
                return currentInstanceMember;
            }
        }
    }
}
